Bump to compact 0.28.0 #62

andrew-fleming · 2026-01-29T03:44:44Z

Types of changes

What types of changes does your code introduce to OpenZeppelin Midnight Contracts?
Put an x in the boxes that apply

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation Update (if none of the other choices apply)

Fixes #59.

Note that the root README badge still shows 0.26.0. Instead of changing it now, this PR proposes to wait until there's a release document for it to point to. This PR could change the badge's version number and keep the link if preferred (but it's easier to forget if the output if correct)

This PR also proposes not to update all the CLI tests that use 0.26.0 as an input value. It's simple to change if it's really desired

PR Checklist

I have read the Contributing Guide
I have added tests that prove my fix is effective or that my feature works
I have added documentation of new methods and any new behavior or changes to existing behavior
CI Workflows Are Passing

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

Summary by CodeRabbit

Chores
- Upgraded Compact toolchain from version 0.26.0 to 0.28.0
- Updated developer tools from 0.1.0 to 0.2.0
- Modernized module imports from CommonJS to ES module format across test fixtures
- Updated language version requirements to 0.19.0
- Updated runtime dependency to version 0.14.0-rc.0

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-29T03:45:03Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🔍 Trigger a full review

Walkthrough

This pull request upgrades the Compact toolchain from version 0.26.0 to 0.28.0 and updates the compact-runtime dependency to 0.14.0-rc.0. The changes include refactoring the simulator core to use new runtime types (StateValue, ChargedState), replacing the CircuitContext structure to use currentQueryContext and costModel instead of originalState and transactionContext, migrating artifact imports from CommonJS to ES modules, and updating Compact contract files to language version 0.19.0 with named imports.

Changes

Cohort / File(s)	Summary
Version Bump - Compact Toolchain `.github/actions/setup/action.yml`, `README.md`, `packages/cli/README.md`	Updated Compact toolchain version from 0.26.0 to 0.28.0 in GitHub Actions configuration and documentation.
Version Bump - Runtime Dependency `package.json`, `packages/simulator/package.json`	Removed `@midnight-ntwrk/compact-runtime` from root dependencies; updated packages/simulator version from ^0.9.0 to 0.14.0-rc.0.
Module Format Migration (CommonJS to ES) `packages/simulator/README.md`, `packages/simulator/test/fixtures/sample-contracts/witnesses/`, `packages/simulator/test/fixtures/utils/address.ts`, `packages/simulator/test/integration/...`, `packages/simulator/test/setup.ts`	Changed artifact import paths from index.cjs to index.js across documentation and test files to use ES modules instead of CommonJS.
Core Simulator API Refactoring `packages/simulator/src/core/AbstractSimulator.ts`, `packages/simulator/src/core/CircuitContextManager.ts`, `packages/simulator/src/core/ContractSimulator.ts`, `packages/simulator/src/types/Simulator.ts`, `packages/simulator/src/utils/CircuitContextUtils.ts`	Replaced CircuitContext structure: transactionContext → currentQueryContext (using QueryContext), originalState removed, added costModel field. Updated type imports: ContractState → StateValue/ChargedState. Modified getContractState() return type and implementation.
Factory and Simulator Setup `packages/simulator/src/factory/createSimulator.ts`	Updated contract address and public state extraction to use currentQueryContext instead of transactionContext; replaced sampleContractAddress with dummyContractAddress.
Compact Language Contract Updates `packages/simulator/test/fixtures/sample-contracts/SampleZOwnable.compact`, `packages/simulator/test/fixtures/sample-contracts/Simple.compact`, `packages/simulator/test/fixtures/sample-contracts/Witness.compact`	Bumped language_version from 0.18.0/0.18.0+ to 0.19.0; replaced default CompactStandardLibrary imports with named imports for specific symbols (Either, Counter, ZswapCoinPublicKey, ContractAddress, etc.).
Test Updates - Type and Import Changes `packages/simulator/test/unit/core/StateManager.test.ts`, `packages/simulator/test/integration/SampleZOwnable.test.ts`, `packages/simulator/test/integration/SampleZOwnableSimulator.ts`, `packages/simulator/test/integration/SimpleSimulator.ts`, `packages/simulator/test/integration/WitnessSimulator.ts`	Updated test imports to use index.js; refactored type references (EncodedQualifiedCoinInfo → EncodedQualifiedShieldedCoinInfo, QualifiedCoinInfo → QualifiedShieldedCoinInfo); replaced originalState/transactionContext assertions with currentQueryContext and costModel; added ChargedState imports.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~35 minutes

Suggested reviewers

emnul

Poem

🐰 Hops of joy for runtime's grace,
CircuitContext finds its new place,
From CommonJS we swiftly flee,
To modules pure, ES modules free!
State and coins now shielded bright,
Version bumps, everything's right! 🚀

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	⚠️ Warning	Changes include refactoring of circuit context structures (ContractState→StateValue, originalState→currentQueryContext, transactionContext→currentQueryContext) and import path updates (.cjs→.js) beyond simple version bumping.	Clarify whether context refactoring and module format changes are part of the 0.28.0 migration requirements or should be separated into distinct PRs for cleaner scope management.
Docstring Coverage	⚠️ Warning	Docstring coverage is 75.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main objective: bumping the Compact toolchain to version 0.28.0, which is the primary focus across all modified files.
Linked Issues check	✅ Passed	PR fulfills linked issue `#59` requirements: Compact version bumped to 0.28.0 across action, READMEs, and package.json; compact-runtime updated to 0.14.0-rc.0 in packages/simulator/package.json.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

.github/actions/setup/action.yml (1)

42-46: Update compact-version to an available release; version 0.28.0 does not exist.

The latest released Compact compiler version is 0.26.0 (October 8, 2025). Version 0.28.0 is not a published release and will cause the setup action to fail. Update to 0.26.0 or verify the correct version number.

🧹 Nitpick comments (2)

packages/cli/README.md (1)

238-244: Align remaining example versions for consistency.

This output block shows 0.28.0, but earlier examples still reference 0.26.0 (e.g., +0.26.0 and programmatic API snippets). Consider updating those to reduce confusion.
packages/simulator/test/unit/core/StateManager.test.ts (1)
99-133: Avoid using QueryContext as the costModel placeholder.

costModel is currently set to modifiedTxCtx (a QueryContext). If the runtime expects a distinct cost model type, this can mask mismatches. Consider reusing the existing context’s costModel (or constructing a proper one) instead.
Suggested tweak
 const newCtx: CircuitContext<SimplePrivateState> = {
   currentQueryContext: modifiedTxCtx,
   currentPrivateState: initialPrivateState,
   currentZswapLocalState: zswapLocalState_1,
-  costModel: modifiedTxCtx,
+  costModel: ctx.costModel,
 };

0xisk

Thank you @andrew-fleming! Looking good! I left some comments.

packages/simulator/package.json

yarn.lock

packages/simulator/test/fixtures/sample-contracts/SampleZOwnable.compact

packages/simulator/test/fixtures/sample-contracts/Simple.compact

packages/simulator/test/fixtures/sample-contracts/Witness.compact

packages/simulator/package.json

emnul

Looks good! I just have an open question about ledger v7

emnul

Quick turnaround ftw! 🚀

0xisk

Thank you @andrew-fleming! Changes look good! Left some comments mainly regarding gasLimit is it excluded as we are dealing with the Simulator so the gasLimit here is useless?

packages/simulator/src/core/ContractSimulator.ts

packages/simulator/src/core/CircuitContextManager.ts

packages/simulator/src/core/AbstractSimulator.ts

packages/simulator/src/utils/CircuitContextUtils.ts

packages/simulator/test/fixtures/utils/address.ts

Co-authored-by: 0xisk <0xisk@proton.me> Signed-off-by: Andrew Fleming <fleming.andrew@protonmail.com>

emnul

Re-approve edits

0xisk

Looks great! thank you @andrew-fleming!

andrew-fleming added 11 commits January 28, 2026 23:47

bump compact version in ci

f5e1600

bump version in readme

b915666

remove unused dep

a56b2c6

bump version in readme

388168b

update imports in snippets

57f7a10

bump compact runtime

664f4b1

update sim src code

25ea596

update tests and imports

3a9cbc8

update yarn.lock

8e8df31

fix comment

1b8f44c

improve comment

0df4369

andrew-fleming requested review from a team as code owners January 29, 2026 03:44

coderabbitai bot reviewed Jan 29, 2026

View reviewed changes

andrew-fleming added 2 commits January 29, 2026 01:29

fix version in cli readme

f198ae6

fix costModel in test

0690919

0xisk requested changes Jan 29, 2026

View reviewed changes

emnul reviewed Jan 29, 2026

View reviewed changes

packages/simulator/package.json Show resolved Hide resolved

emnul reviewed Jan 29, 2026

View reviewed changes

andrew-fleming added 6 commits January 29, 2026 20:21

change compact runtime dep to v14

84ce0a2

update yarn lock to use onchain runtime v2

71c49da

bump lang version to v0.20.0 in contracts

3be37a4

bump to ledger-v7

dd1d8de

fix fmt

51ba3d0

update yarn lock

4412cb2

andrew-fleming requested review from 0xisk and emnul January 29, 2026 23:57

emnul approved these changes Jan 30, 2026

View reviewed changes

0xisk requested changes Jan 30, 2026

View reviewed changes

andrew-fleming and others added 4 commits January 30, 2026 16:17

Apply suggestions from code review

e1b91c1

Co-authored-by: 0xisk <0xisk@proton.me> Signed-off-by: Andrew Fleming <fleming.andrew@protonmail.com>

remove comment

f3b31e2

return gasLimit in circuit ctx

4ef0958

fix fmt

c5aa55b

emnul approved these changes Feb 2, 2026

View reviewed changes

0xisk approved these changes Feb 3, 2026

View reviewed changes

emnul closed this Feb 3, 2026

emnul reopened this Feb 3, 2026

Merge branch 'main' into compact-0.28.0

7d97671

emnul merged commit e665251 into OpenZeppelin:main Feb 3, 2026
6 checks passed

Bump to compact 0.28.0 #62

Bump to compact 0.28.0 #62

Uh oh!

Conversation

andrew-fleming commented Jan 29, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Types of changes

PR Checklist

Further comments

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

0xisk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emnul left a comment

Choose a reason for hiding this comment

Uh oh!

emnul left a comment

Choose a reason for hiding this comment

Uh oh!

0xisk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emnul left a comment

Choose a reason for hiding this comment

Uh oh!

0xisk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

andrew-fleming commented Jan 29, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 29, 2026 •

edited

Loading